<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="DataRequest,org.opensocial.client.base.DataRequest,ActivityRequestFields,DataRequestFields,FilterType,PeopleRequestFields,SortOrder,newActivityRequestParams,newDataRequestParams,newPeopleRequestParams" name="keywords">
<title>org.opensocial.client.base.DataRequest</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'DataRequest - Opensocial Actionscript Client SDK Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Opensocial Actionscript Client SDK</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/opensocial/client/base/DataRequest.html&amp;org/opensocial/client/base/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;DataRequest</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class DataRequest"); titleBar_setSubNav(true,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.opensocial.client.base</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class DataRequest</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">DataRequest <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="BaseType.html">BaseType</a></td>
</tr>
</table>
<p></p>
 Wrapper of <code><j>opensocial.DataRequest</j></code> object in javascript.
 <p>
 This class is just used as a namespace for these constants.
 Different from the javascript API, the data request real logic are implemented seperately in
 <code>org.opensocial.client.jswrapper.Opensocial</code> feature class and restful client 
 class (not exist yet).
 </p>
 <p>
 TODO In future, batch fetch should be supported. So this class needs to be expanded.
 </p>
 <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest" target="mm_external">opensocial.DataRequest</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#newActivityRequestParams()">newActivityRequestParams</a>(first:int = 0, max:int = 20):Object</div>
<div class="summaryTableDescription">[static]
   Prepare an activity request parameter object.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#newDataRequestParams()">newDataRequestParams</a>(escapeType:String = null):Object</div>
<div class="summaryTableDescription">[static]
   Prepare an data request parameter object.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#newPeopleRequestParams()">newPeopleRequestParams</a>(first:int = 0, max:int = 20, details:Array = null, sortOrder:String = null, filter:String = null):Object</div>
<div class="summaryTableDescription">[static]
   Prepare a people request parameter object.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ActivityRequestFields">ActivityRequestFields</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.DataRequest.ActivityRequestFields</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#DataRequestFields">DataRequestFields</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.DataRequest.DataRequestFields</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FilterType">FilterType</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.DataRequest.FilterType</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#PeopleRequestFields">PeopleRequestFields</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.DataRequest.PeopleRequestFields</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#SortOrder">SortOrder</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.DataRequest.SortOrder</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">DataRequest</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="newActivityRequestParams()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">newActivityRequestParams</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function newActivityRequestParams(first:int = 0, max:int = 20):Object</code><p>
   Prepare an activity request parameter object. Keys are defined in 
   <code>DataRequest.ActivityRequestFields</code>.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">first</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The value for <code>DataRequest.ActivityRequestFields.FIRST</code>, default is 0.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">max</span>:int</code> (default = <code>20</code>)<code></code> &mdash; The value for <code>DataRequest.ActivityRequestFields.MAX</code>, default is 20.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The param object.
   </td>
</tr>
</table>
</div>
<a name="newDataRequestParams()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">newDataRequestParams</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function newDataRequestParams(escapeType:String = null):Object</code><p>
   Prepare an data request parameter object. Keys are defined in 
   <code>DataRequest.DataRequestFields</code>.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">escapeType</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The value for <code>DataRequest.DataRequestFields.ESCAPE_TYPE</code>, 
          defined in <code>Globals.EscapeType</code>.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The param object.
   </td>
</tr>
</table>
</div>
<a name="newPeopleRequestParams()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">newPeopleRequestParams</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function newPeopleRequestParams(first:int = 0, max:int = 20, details:Array = null, sortOrder:String = null, filter:String = null):Object</code><p>
   Prepare a people request parameter object. Keys are defined in 
   <code>DataRequest.PeopleRequestFields</code>.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">first</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The value for <code>DataRequest.PeopleRequestFields.FIRST</code>, default is 0.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">max</span>:int</code> (default = <code>20</code>)<code></code> &mdash; The value for <code>DataRequest.PeopleRequestFields.MAX</code>, default is 20.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">details</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; The value for <code>DataRequest.PeopleRequestFields.PROFILE_DETAILST</code>, 
                  which is an array of <code>Person.Field</code>. The default in javascript api 
                  are the person's id, name and thumbnail url. So no need to pass these three 
                  fields here.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">sortOrder</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The value for <code>DataRequest.PeopleRequestFields.SORT_ORDERT</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">filter</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The value for <code>DataRequest.PeopleRequestFields.FILTERT</code>.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The param object.
   </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="ActivityRequestFields"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ActivityRequestFields</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ActivityRequestFields:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.DataRequest.ActivityRequestFields</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.ActivityRequestFields" target="mm_external">opensocial.DataRequest.ActivityRequestFields</a>
</div>
</div>
<a name="DataRequestFields"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">DataRequestFields</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const DataRequestFields:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.DataRequest.DataRequestFields</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.DataRequestFields" target="mm_external">opensocial.DataRequest.DataRequestFields</a>
</div>
</div>
<a name="FilterType"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FilterType</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FilterType:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.DataRequest.FilterType</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.FilterType" target="mm_external">opensocial.DataRequest.FilterType</a>
</div>
</div>
<a name="PeopleRequestFields"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">PeopleRequestFields</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const PeopleRequestFields:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.DataRequest.PeopleRequestFields</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.PeopleRequestFields" target="mm_external">opensocial.DataRequest.PeopleRequestFields</a>
</div>
</div>
<a name="SortOrder"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SortOrder</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const SortOrder:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.DataRequest.SortOrder</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.SortOrder" target="mm_external">opensocial.DataRequest.SortOrder</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">2009 Opensocial</center>
</div>
</body>
</html>
<!--2009 Opensocial-->
